Package com.cisco.pt.ipc.system.impl
Class MultiUserManagerImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.MultiUserManagerImpl
- All Implemented Interfaces:
IPCObject,MultiUserManager
Information provided by the PKI file:
\class MultiUserManager
\brief MultiUserManager is the entry point to all Multiuser functionalities.
\example multiUserManager()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionMultiUserManagerImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:getRemoteNetworkAt(int index) Information provided by the PKI file:getRemoteNetworkByName(String name) Information provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:voidsetAcceptMode(AcceptMode acceptMode) Information provided by the PKI file:voidsetNewRNetAcceptMode(AcceptMode acceptMode) Information provided by the PKI file:voidsetPassword(String password) Information provided by the PKI file:booleanstartServer(int portNumber, String password) Information provided by the PKI file:booleanInformation provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
MultiUserManagerImpl
public MultiUserManagerImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
startServer
Information provided by the PKI file:
\brief Starts the Multiuser server with the specified port number and password. \param portNumber, the port number to listen on. \param password, password. \return bool, true if successful, otherwise false.- Specified by:
startServerin interfaceMultiUserManager- Parameters:
portNumber- Takes in a parameter of portNumberpassword- Takes in a parameter of password- Returns:
- boolean Returns a boolean
-
stopServer
public boolean stopServer()Information provided by the PKI file:
\brief Stops the Multiuser server. \return bool, true if successful, otherwise false.- Specified by:
stopServerin interfaceMultiUserManager- Returns:
- boolean Returns a boolean
-
isServerStarted
public boolean isServerStarted()Information provided by the PKI file:
\brief Returns true if the Multiuser server is started, otherwise false. \return bool, true if the Multiuser server is started, otherwise false.- Specified by:
isServerStartedin interfaceMultiUserManager- Returns:
- boolean Returns a boolean
-
getPortNumber
public int getPortNumber()Information provided by the PKI file:
\brief Returns the port number the Multiuser server is listening on. \return int, the port number the Multiuser server is listening on.- Specified by:
getPortNumberin interfaceMultiUserManager- Returns:
- int Returns a int
-
setPassword
Information provided by the PKI file:
\brief Sets the password for the Multiuser server. \param password, the password for Multiuser server.- Specified by:
setPasswordin interfaceMultiUserManager- Parameters:
password- Takes in a parameter of password
-
getPassword
Information provided by the PKI file:
\brief Returns the password for the Multiuser server. \return QString, the password for the Multiuser server.- Specified by:
getPasswordin interfaceMultiUserManager- Returns:
- String Returns a String
-
setAcceptMode
Information provided by the PKI file:
\brief Sets the existing remote networks accept mode. \param acceptMode, the accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2- Specified by:
setAcceptModein interfaceMultiUserManager- Parameters:
acceptMode- Takes in a parameter of acceptMode
-
getAcceptMode
Information provided by the PKI file:
\brief Returns the existing remote networks accept mode. \return AcceptMode, the accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2- Specified by:
getAcceptModein interfaceMultiUserManager- Returns:
- AcceptMode Returns a AcceptMode
-
setNewRNetAcceptMode
Information provided by the PKI file:
\brief Sets the new remote networks accept mode. \param acceptMode, the accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2- Specified by:
setNewRNetAcceptModein interfaceMultiUserManager- Parameters:
acceptMode- Takes in a parameter of acceptMode
-
getNewRNetAcceptMode
Information provided by the PKI file:
\brief Returns the new remote networks accept mode. \return AcceptMode, the accept mode. Modes: eAlwaysAccept = 0, eAlwaysDeny = 1, ePrompt = 2- Specified by:
getNewRNetAcceptModein interfaceMultiUserManager- Returns:
- AcceptMode Returns a AcceptMode
-
getRemoteNetworkCount
public int getRemoteNetworkCount()Information provided by the PKI file:
\brief Returns the number of remote networks on the workspace. \return int, the number of remote networks on the workspace.- Specified by:
getRemoteNetworkCountin interfaceMultiUserManager- Returns:
- int Returns a int
-
getRemoteNetworkAt
Information provided by the PKI file:
\brief Returns the remote network at the specified index. \param index, the index of the remote network of interest. \return RemoteNetwork, the RemoteNetwork object at the specified index.- Specified by:
getRemoteNetworkAtin interfaceMultiUserManager- Parameters:
index- Takes in a parameter of index- Returns:
- RemoteNetwork Returns a RemoteNetwork
-
getRemoteNetworkByName
Information provided by the PKI file:
\brief Returns the remote network with the specified name. \param name, the name of the remote network of interest. \return RemoteNetwork, the RemoteNetwork object with the specified name.- Specified by:
getRemoteNetworkByNamein interfaceMultiUserManager- Parameters:
name- Takes in a parameter of name- Returns:
- RemoteNetwork Returns a RemoteNetwork
-
getListeningAddresses
Information provided by the PKI file:
\brief Returns the IP addresses the Multiuser server is listening on. \return QString, the IP addresses the Multiuser server is listening on.- Specified by:
getListeningAddressesin interfaceMultiUserManager- Returns:
- String Returns a String
-
writeUdpDatagram
public void writeUdpDatagram()Information provided by the PKI file:
\brief Sends a UDP datagram over the Multiuser connection.- Specified by:
writeUdpDatagramin interfaceMultiUserManager
-
getMulticastSenderIp
Information provided by the PKI file:
\brief Returns the source IP address of the multicast datagram. \return QString, the source IP address of the multicast datagram.- Specified by:
getMulticastSenderIpin interfaceMultiUserManager- Returns:
- String Returns a String
-